package uk.ac.jisc.depositmo.widgets;

/**
 * Copyright (c) 2011, University of Southampton
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 * # Redistributions of source code must retain the above copyright notice, 
 *     this list of conditions and the following disclaimer.
 * # Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation 
 *     and/or other materials provided with the distribution.
 * # Neither the name of the University of Southampton nor the names of its
 *     contributors may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
 *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import java.io.File;

import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;

/**
 * Instances of this class represent the columns in a <code>FileTransferTable</code>.
 * @author Mark Borkum <mark.borkum@gmail.com>
 * @see FileTransferTable
 *
 */
public abstract class FileTransferTableColumn {
	private int style;
	
	private String text;
	
	private int width;
	
	/**
	 * Constructs a new instance of this class given the style value describing its behavior and appearance, an heading value and width.
	 * @param style  the style
	 * @param text  the text
	 * @param width  the width
	 */
	public FileTransferTableColumn(int style, String text, int width) {
		this.setStyle(style);
		this.setText(text);
		this.setWidth(width);
	}

	/**
	 * Returns a new instance of the <code>TableColumn</code> class given the receiver's style, text and width.
	 * @param table
	 * @return  the table column
	 */
	public TableColumn toTableColumn(final Table table) {
		final TableColumn tableColumn = new TableColumn(table, this.getStyle());
		
		tableColumn.setText(this.getText());
		tableColumn.setWidth(this.getWidth());
		
		return tableColumn;
	}
	
	/**
	 * Returns the text for the specified file.
	 * @param file  the file
	 * @return  the text
	 */
	public abstract String toText(File file);
	
	/**
	 * Returns the image for the specified file.
	 * @param display  the display to create the image on
	 * @param file  the file
	 * @return  the image
	 */
	public abstract Image toImage(Display display, File file);
	
	/**
	 * Returns the receiver's style.
	 * @return  the style
	 */
	private int getStyle() {
		return style;
	}

	/**
	 * Sets the receiver's style.
	 * @param style  the new style
	 */
	private void setStyle(int style) {
		this.style = style;
	}

	/**
	 * Returns the receiver's text.
	 * @return  the text
	 */
	private String getText() {
		return text;
	}

	/**
	 * Sets the receiver's text.
	 * @param text  the new text
	 */
	private void setText(String text) {
		this.text = text;
	}

	/**
	 * Returns the receiver's width.
	 * @return  the width
	 */
	private int getWidth() {
		return width;
	}

	/**
	 * Sets the receiver's width.
	 * @param width  the new width
	 */
	private void setWidth(int width) {
		this.width = width;
	}
}
